iMouse投屏 相册列表
调用说明
依赖 iMouse投屏 客户端
/plugin/imcast/* 这一组接口由手机上安装的 iMouse投屏 客户端提供服务,
只在这台设备以 iMouse投屏 方式推流时可用(设备的投屏来源设为 iMouse投屏,或全局投屏模式为 iMouse投屏)。
AirPlay 方式投屏的设备调用会返回 code=70,请改用 /shortcut/album/* 那组快捷指令接口。
这一组接口共有的 code:
| code | 含义 | 怎么处置 |
|---|---|---|
| 70 | 设备当前不是iMouse投屏模式 | 这台现在推上来的流不是 iMouse投屏(在线看实际来源,离线看设置)。把这台的投屏来源改成 iMouse投屏 再投屏,或改用 /shortcut/album/* |
| 71 | iMouse投屏客户端服务不可达 | 看手机:是否在推流、是否停在「访问照片图库」授权框上没点、与电脑是否同网段 |
| 72 | iMouse投屏客户端返回错误 | message 里带客户端的原话(如"图片不存在"),按原话处置 |
| 73 | 相册权限未授权 | 手机「设置 → 隐私与安全性 → 照片」里给 iMouse投屏 选「完全访问」 |
首次使用要在手机上点一次授权
第一次调相册接口时手机会弹出「"iMouse投屏"想访问你的照片图库」,要在手机上点允许完全访问。 点之前所有相册请求都会一直等到超时(返回 71)。
取手机相册列表。相机胶卷(全部照片)是 type=smart,用户自建相册是 type=album。
- 请求参数
| 参数 | 类型 | 说明 | 备注 |
|---|---|---|---|
| fun | 字符串 | /plugin/imcast/album/list | 请求功能名 |
| id | 字符串 | 设备id | 不允许多个 |
| outtime | 整数 | 超时时间 | 单位毫秒,不传或 0 用内核配置(默认 15 秒) |
- httpGet请求示例
curl --request GET \
--url 'http://192.168.9.9:9911/api/plugin/imcast/album/list?id=6C:8D:C1:67:04:29'
- httpPost请求示例
curl --request POST \
--url http://192.168.9.9:9911/api \
--header "content-type: multipart/form-data" \
--form "fun=/plugin/imcast/album/list" \
--form "id=6C:8D:C1:67:04:29"
- httpPost json请求示例【websocket也可发送同样json请求】
curl --request POST \
--url http://192.168.9.9:9911/api \
--header 'Content-Type: application/json' \
--data '{
"fun": "/plugin/imcast/album/list",
"data": {
"id": "6C:8D:C1:67:04:29"
}
}'
响应结果
{
"data": {
"list": [
{
"id": "F0F7D8C3-FA51-4AFB-A6B8-9EDF81F7A4C2/L0/040",
"name": "所有照片",
"type": "smart",
"count": 6,
"is_camera_roll": true
},
{
"id": "57AB2D83-F098-4C67-886E-D7439A5E8DCC/L0/040",
"name": "imcast测试",
"type": "album",
"count": 2,
"is_camera_roll": false
}
],
"total": 2,
"code": 0,
"id": "6C:8D:C1:67:04:29",
"message": "成功"
},
"status": 200,
"message": "成功",
"msgid": 0,
"fun": "/plugin/imcast/album/list"
}
- 响应data数据字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| total | 整数 | 相册总数 |
| list[].id | 字符串 | 相册 id,「图片列表」「清空相册」可用它定位 |
| list[].name | 字符串 | 相册名(手机本地语言) |
| list[].type | 字符串 | smart 系统智能相册(相机胶卷、截图);album 用户自建 |
| list[].count | 整数 | 相册内照片数 |
| list[].is_camera_roll | 布尔值 | 是否相机胶卷 |
备注
手机上一张照片都没有时 list 为空数组、total 为 0,相机胶卷也不会列出来。